Skip to content

docs: simplify malware analysis for query-only, keyless workflow#76

Merged
Sahilb315 merged 3 commits into
mainfrom
claude/malware-analysis-docs-update
Jul 23, 2026
Merged

docs: simplify malware analysis for query-only, keyless workflow#76
Sahilb315 merged 3 commits into
mainfrom
claude/malware-analysis-docs-update

Conversation

@KunalSin9h

Copy link
Copy Markdown
Member

Summary

Active (on-demand) malware analysis has been retired in vet (see safedep/vet#752). Scanning is now a fast lookup against SafeDep's known malicious packages database and requires no API key. This PR updates the Malware Analysis page (and one stale FAQ reference) to match.

Changes

governance/cloud/malware-analysis.mdx

  • Reframed the page around querying known malicious packages with --malware-query (noted --malware as a deprecated alias that behaves identically).
  • Dropped the mandatory API key / SafeDep Cloud onboarding requirement; clarified that a cloud account is optional (report sync, higher rate limits).
  • Removed content that only applied to on-demand analysis:
    • the --malware-analysis-timeout flag and the "Timeout Configuration" section (the flag is now a deprecated no-op);
    • the "waits for a timeout period … async" note;
    • the entire Package Inspection section — vet inspect malware has been retired and now returns a useful error, so the doc no longer instructs users to run it (also removed the corresponding bottom card and the VET_ENABLE_PACKAGE_INSPECT_COMMAND step).
  • Made CI examples (GitLab, Jenkins) keyless and switched them to --malware-query.
  • Renamed "Analysis Techniques" → "How Packages Are Analyzed" and clarified that SafeDep performs the analysis continuously in the cloud while vet queries the results.
  • Reworked Troubleshooting: removed the timeout and authentication accordions (no auth needed); added a "package not flagged" note explaining only already-known packages are reported.

faq.mdx

  • Updated the performance FAQ that recommended --malware --malware-analysis-timeout 5m to reflect the fast keyless --malware-query lookup.

Notes for reviewers

  • The vet-action GitHub Actions example was kept but reframed: known-malicious detection needs no key, and the cloud-key/cloud-tenant config is called out as optional for cloud reporting only. If vet-action exposes a more precise keyless malware invocation, happy to adjust.
  • I intentionally scoped this to the malware-analysis page plus the one contradicting FAQ example. A repo-wide grep found no other pages referencing the retired flags/command.

🤖 Generated with Claude Code


Generated by Claude Code

On-demand (active) malware analysis has been retired in vet; scanning is
now a fast lookup against SafeDep's known malicious packages database and
requires no API key.

- Reframe the page around querying known malicious packages via
  `--malware-query` (`--malware` noted as a deprecated alias)
- Drop the mandatory API key / SafeDep Cloud onboarding requirement;
  clarify cloud is optional (report sync, higher rate limits)
- Remove the on-demand-only content: `--malware-analysis-timeout`,
  the async submit/wait note, and the retired `vet inspect malware`
  package inspection section
- Make CI examples (GitLab, Jenkins) keyless and use `--malware-query`
- Update FAQ performance note that referenced the removed timeout flag

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EDuuXuxJY4kUsEijVwskr7
@safedep

safedep Bot commented Jul 23, 2026

Copy link
Copy Markdown

SafeDep Report Summary

Green Malicious Packages Badge Green Vulnerable Packages Badge Green Risky License Badge

No dependency changes detected. Nothing to scan.

View complete scan results →

This report is generated by SafeDep Github App

@KunalSin9h
KunalSin9h requested a review from Sahilb315 July 23, 2026 08:07
Comment thread governance/cloud/malware-analysis.mdx Outdated
Comment thread governance/cloud/malware-analysis.mdx Outdated
Comment thread governance/cloud/malware-analysis.mdx Outdated
KunalSin9h and others added 2 commits July 23, 2026 10:06
- Move the no-API-key information out of the Requirements steps into a
  standalone note (Requirements now has the single Install Vet step)
- Remove the em dash per docs style
- Link Vet install to the installation section

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EDuuXuxJY4kUsEijVwskr7
Requirements has a single item now, so a plain statement reads better
than a one-step timeline.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EDuuXuxJY4kUsEijVwskr7
@KunalSin9h
KunalSin9h requested a review from Sahilb315 July 23, 2026 11:02
@Sahilb315
Sahilb315 merged commit 01a5a8b into main Jul 23, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants